man: document commit signing
authorDenis Pynkin <denis.pynkin@collabora.com>
Sun, 10 Nov 2019 16:17:58 +0000 (19:17 +0300)
committerDenis Pynkin <denis.pynkin@collabora.com>
Wed, 25 Mar 2020 12:23:54 +0000 (15:23 +0300)
Added options descriptions for `ostree-commit` allowing
to sign the commit.

Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
man/ostree-commit.xml

index c64a7a00e93365ed2f22614b5b5d1c1e72aa774d..2c821fc114e36c02db5c57634b7be0a7a2880e57 100644 (file)
@@ -251,6 +251,39 @@ Boston, MA 02111-1307, USA.
                     POLICY is a boolean which specifies whether fsync should be used or not.  Default to true.
                 </para></listitem>
             </varlistentry>
+
+            <varlistentry>
+                <term><option>-s, --sign-type</option></term>
+                <listitem><para>
+                    Use particular signature engine. Currently
+                    available <arg choice="plain">ed25519</arg> and <arg choice="plain">dummy</arg>
+                    signature types.
+
+                    The default is <arg choice="plain">ed25519</arg>.
+                </para></listitem>
+
+            </varlistentry>
+            <varlistentry>
+                <term><option>--sign</option>="KEY-ID"</term>
+                <listitem><para>
+                        There <literal>KEY-ID</literal> is:
+                        <variablelist>
+                            <varlistentry>
+                                <term><option>for ed25519:</option></term>
+                                <listitem><para>
+                                        <literal>base64</literal>-encoded secret key for commit signing.
+                                </para></listitem>
+                            </varlistentry>
+
+                            <varlistentry>
+                                <term><option>for dummy:</option></term>
+                                <listitem><para>
+                                            ASCII-string used as secret key.
+                                </para></listitem>
+                            </varlistentry>
+                        </variablelist>
+                </para></listitem>
+            </varlistentry>
         </variablelist>
     </refsect1>